配置外部 API ​

API 配置 ​

接下来，我们配置一个外部 api 来访问刚创建的 book 模型。

api 配置需要保存在目录apis下。

创建配置文件：apis/book.http.yao

{
  "name": "BOOK 外部接口 ",
  "version": "1.0.0",
  "description": "BOOK 外部接口",
  "guard": "-",
  "group": "v1",
  "paths": [
    {
      "path": "book",
      "method": "GET",
      "guard": "-",
      "process": "models.book.get", //内置的模型处理器
      "in": [":params"],
      "out": { "status": 200, "type": "application/json" }
    }
  ]
}

以上配置会向 yao 引擎注册一个外部访问的 api 接口。

api 的路径的规则是http(s)://host:port/api/group/path,包含以下几部分：

• 主机与接口。
• 固定前缀/api。
• api 中配置的 group,这里配置的是 v1,group 可以包含斜杠/，区分大小写。
• api 中配置的 path,paths 节点中每一条记录都是一个访问端点，区分大小写。

最终生成的的 api 访问地址是http://127.0.0.1:5099/api/v1/book。

测试 api 接口，使用命令行工具或是浏览器浏览地址。

curl http://127.0.0.1:5099/api/v1/book

[{"author":"1212","id":1,"publisher":"1212","title":"1212"},{"author":"12","id":3,"publisher":"12","title":"12"}]

API 详细的说明参考官方文档：API

总结 ​

在 API 定义中使用现成的处理器，快速开发 API 接口。